Улучшена "архитектура" документации и настроен triage для issues#801
Open
deexsed wants to merge 3 commits intoFlowseal:mainfrom
Open
Улучшена "архитектура" документации и настроен triage для issues#801deexsed wants to merge 3 commits intoFlowseal:mainfrom
deexsed wants to merge 3 commits intoFlowseal:mainfrom
Conversation
deexsed
changed the title
Flowseal
requested changes
Apr 30, 2026
Comment on lines
+7
to
+55
| - type: input | ||
| id: app_version | ||
| attributes: | ||
| label: Версия TG WS Proxy | ||
| description: Укажите версию приложения (например, v1.2.3) | ||
| placeholder: vX.Y.Z | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: Операционная система | ||
| description: На какой ОС воспроизводится проблема? | ||
| options: | ||
| - Windows | ||
| - macOS | ||
| - Linux | ||
| - Другая | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Шаги для воспроизведения | ||
| description: Опишите шаги, после которых возникает проблема | ||
| placeholder: | | ||
| 1. ... | ||
| 2. ... | ||
| 3. ... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Ожидаемое поведение | ||
| description: Что должно было произойти? | ||
| placeholder: Кратко опишите ожидаемый результат | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| id: actual | ||
| attributes: | ||
| label: Опишите вашу проблему | ||
| description: Чётко опишите проблему с которой вы столкнулись | ||
| placeholder: Описание проблемы | ||
| label: Фактическое поведение | ||
| description: Что произошло на самом деле? | ||
| placeholder: Кратко опишите фактический результат |
Owner
There was a problem hiding this comment.
Не нужно. Отбивает всякое желание писать issue
Owner
There was a problem hiding this comment.
Указание версии + описание проблемы достаточно
Comment on lines
+7
to
+16
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Какую проблему решает предложение? | ||
| description: Опишите текущую боль или ограничение, с которым вы столкнулись | ||
| placeholder: | | ||
| Сейчас ... | ||
| Это неудобно, потому что ... | ||
| validations: | ||
| required: true |
Owner
There was a problem hiding this comment.
Из описания предложения можно самому осознать проблематику. Не нужно заставлять пользователя тратить время на это
Comment on lines
+29
to
+38
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Рассмотренные альтернативы | ||
| description: Опишите альтернативные варианты, если вы их рассматривали | ||
| placeholder: | | ||
| Вариант 1 ... | ||
| Вариант 2 ... | ||
| validations: | ||
| required: false |
| @@ -0,0 +1,57 @@ | |||
| name: ❓ Вопрос / Поддержка | |||
Owner
There was a problem hiding this comment.
Это можно отнести к проблеме, не нужно
| @@ -0,0 +1,127 @@ | |||
| name: Issue SLA Reminder | |||
Comment on lines
+60
to
+62
| - [Windows](./README.windows.md) | ||
| - [macOS](./README.macos.md) | ||
| - [Linux](./README.linux.md) |
Comment on lines
+68
to
+71
| ## Дополнительные инструкции | ||
|
|
||
| Ключ **`check_updates`** — при `true` при запросе к GitHub сравнивается версия с последним релизом (только уведомление и ссылка на страницу загрузки). На Windows в конфиге может быть **`autostart`** (автозапуск при входе в систему). | ||
| - [Fake TLS + upstream в Nginx](./FakeTlsNginx.md) | ||
| - [Файлы конфигурации Tray-приложения](./TrayConfig.md) |
Owner
There was a problem hiding this comment.
Этот блок тоже не нужен (секция навигации покрывает его)
| - [macOS](./README.macos.md) | ||
| - [Linux](./README.linux.md) | ||
|
|
||
| ## Установка из исходников |
Owner
There was a problem hiding this comment.
Этот блок тоже не нужен (секция навигации покрывает его)
| 3. Выберите подходящий шаблон: | ||
| - `Проблема` — для багов, | ||
| - `Предложение` — для новых возможностей, | ||
| - `Вопрос / Поддержка` — для вопросов по настройке и использованию. |
Comment on lines
+52
to
+57
| В описании PR укажите: | ||
|
|
||
| - цель изменения; | ||
| - что именно изменено; | ||
| - как это проверить; | ||
| - для какой ОС (если применимо). |
Owner
There was a problem hiding this comment.
Если человек догадался открыть PR, то не надо ему объяснять, что в нем писать
Contributor
Author
|
Помимо указанных замечаний в |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Разделил docs/README.md на отдельные файлы по ОС и вынес дополнительные инструкции в отдельные документы.
Привел формулировки и разметку документации к единому стилю.
Добавил CONTRIBUTING.md и ссылку на него из документации.
Расширил шаблоны issues: баг, предложение, вопрос/поддержка.
Добавил .github/ISSUE_TEMPLATE/config.yml и отключил пустые issue.
Добавил workflow triage: автоответы для type: проблема, type: предложение, type: вопрос.
Добавил автопереход статусов: при первом комментарии мейнтейнера ставится status: в работе и снимается status: нуждается в сортировке.
Добавил SLA-напоминание для багов без ответа и сделал порог SLA настраиваемым.
Добавил .github/labels.md с фиксированным списком лейблов и минимальный .github/CODEOWNERS.
В некоторых местах возможно нужно подредактировать\дополнить ответами из раздела discussions. Все yml писал нейронкой, так что могут быть косяки, сообщите исправлю\удалю если не надо